home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_apache2.idb / usr / freeware / apache2 / include / apr_dso.h.z / apr_dso.h
C/C++ Source or Header  |  2002-07-08  |  4KB  |  131 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  */
  54.  
  55. #ifndef APR_DSO_DOT_H
  56. #define APR_DSO_DOT_H
  57.  
  58. #include "apr.h"
  59. #include "apr_pools.h"
  60. #include "apr_errno.h"
  61. /**
  62.  * @file apr_dso.h
  63.  * @brief APR Dynamic Object Handling Routines
  64.  */
  65.  
  66.  
  67. /**
  68.  * @defgroup APR_DSO Dynamic Object Handling
  69.  * @ingroup APR
  70.  * @{
  71.  */
  72.  
  73. #ifdef __cplusplus
  74. extern "C" {
  75. #endif
  76.  
  77. #if APR_HAS_DSO || defined(DOXYGEN)
  78.  
  79. /**
  80.  * Structure for referencing dynamic objects
  81.  * @defvar apr_dso_handle_t
  82.  */
  83. typedef struct apr_dso_handle_t       apr_dso_handle_t;
  84.  
  85. /**
  86.  * Structure for referencing symbols from dynamic objects
  87.  * @defvar apr_dso_handle_sym_t
  88.  */
  89. typedef void *                        apr_dso_handle_sym_t;
  90.  
  91. /**
  92.  * Load a DSO library.
  93.  * @param res_handle Location to store new handle for the DSO.
  94.  * @param path Path to the DSO library
  95.  * @param ctx Pool to use.
  96.  */
  97. APR_DECLARE(apr_status_t) apr_dso_load(apr_dso_handle_t **res_handle, 
  98.                                        const char *path, apr_pool_t *ctx);
  99.  
  100. /**
  101.  * Close a DSO library.
  102.  * @param handle handle to close.
  103.  */
  104. APR_DECLARE(apr_status_t) apr_dso_unload(apr_dso_handle_t *handle);
  105.  
  106. /**
  107.  * Load a symbol from a DSO handle.
  108.  * @param ressym Location to store the loaded symbol
  109.  * @param handle handle to load the symbol from.
  110.  * @param symname Name of the symbol to load.
  111.  */
  112. APR_DECLARE(apr_status_t) apr_dso_sym(apr_dso_handle_sym_t *ressym, 
  113.                                       apr_dso_handle_t *handle,
  114.                                       const char *symname);
  115.  
  116. /**
  117.  * Report more information when a DSO function fails.
  118.  * @param dso The dso handle that has been opened
  119.  * @param buf Location to store the dso error
  120.  * @param bufsize The size of the provided buffer
  121.  */
  122. APR_DECLARE(const char *) apr_dso_error(apr_dso_handle_t *dso, char *buf, apr_size_t bufsize);
  123.  
  124. #endif /* APR_HAS_DSO */
  125.  
  126. #ifdef __cplusplus
  127. }
  128. #endif
  129. /** @} */
  130. #endif
  131.